<?php
/**
 * Copyright 2011  SURFfoundation
 * 
 * This file is part of ESCAPE.
 * 
 * ESCAPE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * ESCAPE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with ESCAPE.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * For more information:
 * http://escapesurf.wordpress.com/
 * http://www.surffoundation.nl/
 * 
 * Contact: d.vierkant@utwente.nl
 * 
 * @license http://www.gnu.org/licenses/gpl.html GNU GPLv3
 */
?>
<?php
	/* @var $repository escape_repository_Repository */
	$repository =& $this->requestAttributes['repository'];
	/* @var $repositoryUi escape_repository_Repository */
	$repositoryUi =& $this->requestAttributes['repositoryUi'];
	
	$templateVariables = array();
	$templateVariables['title'] = 'ESCAPE: editors manual';
	$this->requestAttributes['templateVariables'] =& $templateVariables;
?>
<?php $this->displayHeader(); ?>

<div class="escape_Section">

<div class="escape_SectionTitle">ESCAPE: editors manual</div>

<p>
This manual tells you more about the use of ESCAPE from the editor's perspective, both in general (what to use for) and more in detail the functionalities in ESCAPE.
</p>

<ul>
<li><a href="#whatcanyoudowithescape">What can you do with ESCAPE?</a></li>
<li><a href="#permissionstructure">Permission structure</a></li>
<li><a href="#whatisanaggregation">What is <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?>?</a></li>
<li><a href="#buildinganaggregation">Building <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?></a></li>
<li><a href="#whatisanobject">What is an object</a></li>
<li><a href="#addinganobject">Adding an object</a></li>
<li><a href="#editingmetadatadescriptions">Editing metadata descriptions</a></li>
<li><a href="#removingobjectsfilespropertiesorrelations">Removing objects, files, properties or relations</a></li>
<li><a href="#removinganaggregation">Removing <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?></a></li>
</ul>

<a name="whatcanyoudowithescape"></a>
<div class="escape_SectionTitle">What can you do with ESCAPE?</div>

<p>
With ESCAPE you can bring together - aggregate - all kinds of objects (web representations of documents, persons, organizations, etc.), relate them to each other and add descriptions to these objects and relations.
A document is an object which contains the output of work in text, video, audio, images, numbers, etc.
</p>

<p>
Usage examples:
</p>
<ul>
<li>Presenting yourself, your organization or your work within the context of a network of related objects.</li>
<li>Making enhanced publications: linking of documents or parts of documents to related items like video, data sets, and citing publications.</li>
<li>Collecting and relating publications around theoretical concepts for instance in the context of scientific debate or in an educational setting.</li>
</ul>

<a name="permissionstructure"></a>
<div class="escape_SectionTitle">Permission structure</div>

<p>
ESCAPE is about <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregations']); ?>.
ESCAPE has a two stage structure of permissions for <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> actions.
Users can receive permissions either through a global system role or <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?> specific role.
</p>

<p>
The following table gives an overview of the permissions for each role.
</p>

<table class="escape_ListTable">
<tr>
<th><?php print htmlspecialchars(ucfirst($repositoryUi->repository->config['label_aggregation'])); ?> actions</th>
<th colspan="2" style="text-align: center">System roles</th>
<th colspan="2" style="text-align: center"><?php print htmlspecialchars(ucfirst($repositoryUi->repository->config['label_aggregation'])); ?> roles</th>
</tr>
<tr>
<td></td>
<td style="text-align: center">Administrator</td>
<td style="text-align: center">Creator</td>
<td style="text-align: center">Owner</td>
<td style="text-align: center">Editor</td>
</tr>
<tr>
<td>Creating <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregations']); ?></td>
<td style="text-align: center">X</td>
<td style="text-align: center">X</td>
<td style="text-align: center"></td>
<td style="text-align: center"></td>
</tr>
<tr>
<td>Deleting <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregations']); ?></td>
<td style="text-align: center">X</td>
<td style="text-align: center"></td>
<td style="text-align: center">X</td>
<td style="text-align: center"></td>
</tr>
<tr>
<td>Changing <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?></td>
<td style="text-align: center">X</td>
<td style="text-align: center"></td>
<td style="text-align: center">X</td>
<td style="text-align: center"></td>
</tr>
<tr>
<td>Editing <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregations']); ?></td>
<td style="text-align: center">X</td>
<td style="text-align: center"></td>
<td style="text-align: center">X</td>
<td style="text-align: center">X</td>
</tr>
</table>

<p>
Permissions gained through a system role apply throughout the whole system.
Additional permissions can be gained through <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> specific roles.
</p>

<p>
An editor can only edit the <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> in which the editor role is assigned.
<?php print htmlspecialchars(ucfirst($repositoryUi->repository->config['label_aggregations'])); ?> can only be created by users with the system role administrator or creator.
<?php print htmlspecialchars(ucfirst($repositoryUi->repository->config['label_an_aggregation'])); ?> editor does not have permissions to create or delete <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregations']); ?>, nor can an editor assign <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> roles to other users.
</p>

<p>
For <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> roles there is a distinction between editors and owners.
Whereas an editor can only edit a specific <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?>, an owner also can delete or grant <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> roles to other users.
If you are not the owner of a specific <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> you can become editor or owner of that <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> by creating an account from the ESCAPE login page and asking the owner of the <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> to assign the editor or owner role to you.
</p>

<p>
The following text simply refers to 'editor' where in fact 'editor and owner' can be read.
</p>

<a name="whatisanaggregation"></a>
<div class="escape_SectionTitle">What is <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?>?</div>

<p>
<?php print htmlspecialchars(ucfirst($repositoryUi->repository->config['label_an_aggregation'])); ?> is a collection of related objects on the web.
</p>

<a name="buildinganaggregation"></a>
<div class="escape_SectionTitle">Building <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?></div>

<p>
An editor can collect objects in <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?>.
Creating a new <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> however is limited to users with the system role administrator or creator (see Access and rights).
</p>

<a name="whatisanobject"></a>
<div class="escape_SectionTitle">What is an object</div>

<p>
An object is a digital representation of any type of information on the web having a uniform resource locator (URL).
An object can be a document as well as for instance a person.
Objects can be the PDF of a document somewhere on the web or the web page of a person, organization, project, etc.
</p>

<a name="addinganobject"></a>
<div class="escape_SectionTitle">Adding an object</div>

<p>
Using ESCAPE as an editor you need a login account.
If you are not the owner of the <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> you should request the owner to assign the editor role to you.
</p>

<p>
You can add a new object by the following steps:
</p>

<ol>
<li>Click on 'Add a new object'.</li>
<li>Select the type of object you want to add.</li>
<li>Fill in the title, name or label of the object.</li>
<li>Type or copy the URL of the object:
<ol>
<li>For documents use persistent URLs and open access as much as possible.</li> 
<li>If you do not have a URL (for instance because a person has no adequate representation on the web<?php
	// check if upload is enabled
	if($repository->config['upload_enabled'])
	{
?>
, or because the object you want to add will be made available on the web by means of uploading to the ESCAPE repository, see 9
<?php
	}
?>), leave this field blank and the system generates a URL for the new object.</li>
</ol>
</li>
<li>In order to automatically extract information for describing the object (metadata) from the website of the object, click on 'extract metadata'. Next you can check the suggested metadata.</li>
<li>Click on 'Add new [<em>object type</em>]'</li>
<li>Fill in additional metadata for description of the object.</li>
<li>Add
<ol>
<li>new properties for additional description of the object</li>
<li>relations
<ol> 
<li>to a new object you want to include in the <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> or</li> 
<li>to an existing object in the <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?>.</li>
</ol> 
You can annotate a relation after saving the object to be related.
Mind the way you use this functionality: the description should really concern the relation and not (one of) the objects!
</li>
</ol>
</li>
<?php
	// check if upload is enabled
	if($repository->config['upload_enabled'])
	{
?>
<li>If the object is not on the web but stored on a local computer just leave this URL field blank, click on 'Add new [<em>object type</em>]' and attach a file to this object.</li>
<?php
	}
?>
</ol>

<a name="editingmetadatadescriptions"></a>
<div class="escape_SectionTitle">Editing metadata descriptions</div>

<p>
Editing metadata descriptions
</p>

<ul>
<li>Click 'Edit' behind the object name or title.</li>
<li>Use <img src="/rsc/img/add.gif" alt="Add" /> to add text</li>
<li>Use <img src="/rsc/img/edit.gif" alt="Edit" /> to change text</li>
</ul>

<a name="removingobjectsfilespropertiesorrelations"></a>
<div class="escape_SectionTitle">Removing objects, files, properties or relations</div>

<p>
Removing an object:
</p>

<ul>
<li>Click 'Edit' behind the object name or title</li>
<li>Click 'Delete' behind 'Object: [<em>object type</em>]'</li> 
</ul>

<p>Removing a file attached tot an object:</p>

<ul>
<li>Click 'Edit' behind the object name or title</li>
<li>Click 'Delete' behind 'Attached file: ...' </li>
</ul>

<p>Removing properties or relations:</p>

<ul>
<li>Click 'Edit' behind the object name or title</li>
<li>Click on <img src="/rsc/img/edit.gif" alt="Edit" /> behind the property of relation</li>
<li>Click on the Remove-button</li>
</ul>

<a name="removinganaggregation"></a>
<div class="escape_SectionTitle">Removing <?php print htmlspecialchars($repositoryUi->repository->config['label_an_aggregation']); ?></div>

<p>
<?php print htmlspecialchars(ucfirst($repositoryUi->repository->config['label_an_aggregation'])); ?> can only be removed by the owner of the <?php print htmlspecialchars($repositoryUi->repository->config['label_aggregation']); ?> or by the system administrator
</p>

</div>


<?php $this->displayFooter(); ?>
